home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / psal10.zip / PROSCRIB.DOC < prev    next >
Text File  |  1992-06-27  |  35KB  |  864 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.                     ███████┐ ███████┐              ProScribe Archive Laboratory
  10.                     ██┌──██│ ██┌────┘
  11.                     ███████│ ███████┐                A Generic Upload Processor
  12.                     ██┌────┘ └────██│
  13.                     ██│      ███████│            For Use With Most BBS Software
  14.                     └─┘      └──────┘
  15.  
  16.  
  17.  
  18.                           ProScribe Archive Laboratory
  19.  
  20.                                    Version 1.0
  21.  
  22.                         Copyright  (C) 1992 Brett Nyborg
  23.                      Documentation Written by Rizwan Rasheed
  24.                   Registration & Some Routines by Damian Frank
  25.                     Fidonet 1:114/139  USTG/ITCNet 85:823/130
  26.                          All Rights Reserved, Worldwide
  27.  
  28.  
  29.                             PLEASE REFER TO WHATS.NEW
  30.                      FOR DETAILS OF RECENT PROGRAM CHANGES!
  31.                  ProScribe Archive Laboratory v1.0 Documentation      Page 1
  32.  
  33.  
  34.                                   Table of Contents
  35.         _________________________________________________________________
  36.  
  37.      Introduction  . . . . . . . . . . . . . . . . . . . . . . . . . . . .   2
  38.  
  39.      Program Features  . . . . . . . . . . . . . . . . . . . . . . . . . .   3
  40.  
  41.      Program Descriptions  . . . . . . . . . . . . . . . . . . . . . . . .   5
  42.  
  43.      Status Display  . . . . . . . . . . . . . . . . . . . . . . . . . . .   6
  44.  
  45.      ProScribe Installation / Configuration Utility  . . . . . . . . . . .   8
  46.  
  47.           ProScribe Installation . . . . . . . . . . . . . . . . . . . . .   8
  48.  
  49.           Navigating Through The ProScribe Setup Utility . . . . . . . . .   8
  50.  
  51.                Path Names  . . . . . . . . . . . . . . . . . . . . . . . .   9
  52.  
  53.                Archivers . . . . . . . . . . . . . . . . . . . . . . . . .  10
  54.  
  55.                Colors  . . . . . . . . . . . . . . . . . . . . . . . . . .  10
  56.  
  57.                COM Port  . . . . . . . . . . . . . . . . . . . . . . . . .  10
  58.  
  59.                Archive Comments  . . . . . . . . . . . . . . . . . . . . .  10
  60.  
  61.                Toggles . . . . . . . . . . . . . . . . . . . . . . . . . .  11
  62.  
  63.                Miscellaneous . . . . . . . . . . . . . . . . . . . . . . .  11
  64.  
  65.      Command Line Syntax . . . . . . . . . . . . . . . . . . . . . . . . .  13
  66.  
  67.      Batch File Construction . . . . . . . . . . . . . . . . . . . . . . .  14
  68.  
  69.      Errorlevels . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  17
  70.  
  71.      The ADDCRC.EXE Program  . . . . . . . . . . . . . . . . . . . . . . .  18
  72.  
  73.      The MKERRLVL.EXE Program  . . . . . . . . . . . . . . . . . . . . . .  19
  74.  
  75.      Bug Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  20
  76.  
  77.      Registration Information  . . . . . . . . . . . . . . . . . . . . . .  21
  78.  
  79.      Disclaimer  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  22
  80.  
  81.      Distributors  . . . . . . . . . . . . . . . . . . . . . . . . . . . .  23
  82.                  ProScribe Archive Laboratory v1.0 Documentation      Page 2
  83.  
  84.  
  85.                                   Introduction
  86.         _________________________________________________________________
  87.  
  88.      ProScribe is a generic upload processor designed to run on almost any BBS
  89.      software package.  ProScribe currently handles ARJ, LZH & ZIP file formats. 
  90.      ProScribe's main function is to test incoming files for integrity errors,
  91.      virus infections, and removal of any known BBS ads by their CRC values
  92.      listed in a database of CRC values supplied with this archive.  There are
  93.      more options to the program, and will be discussed in length in the main
  94.      documentation.
  95.  
  96.      ProScribe was written because the majority of existing upload processors in
  97.      the market are/were designed to work with PCBoard only.  ProScribe will
  98.      work with almost ANY BBS package that is able to send a complete filename
  99.      and path specification of the uploaded file as a DOS parameter.  If a batch
  100.      upload is received, ProScribe will still work correctly, provided that the
  101.      BBS program sends the filename and path specification of each individual
  102.      file in sequence.
  103.                  ProScribe Archive Laboratory v1.0 Documentation      Page 3
  104.  
  105.  
  106.                                 Program Features
  107.         _________________________________________________________________
  108.  
  109.      ■    File integrity testing upon unarchiving.
  110.           BENEFIT:  Detection of bad uploads.  Bad uploads can be moved into a
  111.                     hold directory, if desired.
  112.  
  113.      ■    Archive format detection by signature using the included ARC-ID
  114.           software, and NOT just by the filename extension.
  115.           BENEFIT:  A failsafe method of determining the archive format.
  116.  
  117.      ■    Virus scanning, using McAfee's SCAN.EXE.
  118.           BENEFIT:  Early detection of potentially dangerous uploads.  Uploads
  119.                     that do not pass the virus scan test can be moved into a
  120.                     hold directory, if desired.
  121.  
  122.      ■    File date checking.
  123.           BENEFIT:  Enables the sysop to specify the age-limit of the incoming
  124.                     files he/she will allow to be uploaded to the BBS.
  125.  
  126.      ■    BBS ad(s) removal.
  127.           BENEFIT:  Gets rid of common BBS ads.
  128.  
  129.      ■    BBS ad insertion.
  130.           BENEFIT:  Inserts your favorite BBS ad into uploaded file(s).
  131.  
  132.      ■    Archive commenting (ZIP & ARJ formats only).
  133.           BENEFIT:  A more simple method of BBS advertising.
  134.  
  135.      ■    Conditional re-archiving.
  136.           BENEFIT:  If the file is unmodified during processing (no BBS ads
  137.                     added and no BBS ads removed), large amounts of processing
  138.                     time will be saved through the skipping of re-archiving.
  139.  
  140.      ■    Definitive setup program.
  141.           BENEFIT:  Ease of installation and configuration.
  142.  
  143.      ■    Up to 10 archive comments can be specified, selectable by default or
  144.           by a command line switch.
  145.           BENEFIT:  
  146.  
  147.      ■    Up to 2 BBS ads can be inserted.
  148.           BENEFIT:
  149.  
  150.      ■    Multiple exit errorlevels.
  151.           BENEFIT:  Enables the sysop to determine the urgency of the situation
  152.                     and handle it his/her own way.
  153.  
  154.  
  155.  
  156.  
  157.  
  158.                  ProScribe Archive Laboratory v1.0 Documentation      Page 4
  159.  
  160.  
  161.      ■    Sysop definable colors.
  162.           BENEFIT:  Allows the sysop to personalize ProScribe to a certain
  163.                     extent.
  164.      ■    Editable & viewable BBS ad database.
  165.           BENEFIT:  Allows the sysop to expand his/her library of BBS ads that
  166.                     he/she wants removed.
  167.  
  168.      ■    Graphical display, shown locally and to the user:  
  169.           BENEFIT:  Keeps the user entertained while processing the upload.
  170.  
  171.      ■    Upload logfile.
  172.           BENEFIT:  Allows the sysop to, at a glance, look at his/her uploads
  173.                     and determine the cause(s) of errors, if any.
  174.  
  175.      ■    Hold directory.
  176.           BENEFIT:  ProScribe will automatically move any uploads that did not
  177.                     pass any part of the processing into a sysop-defined
  178.                     directory.
  179.  
  180.      ■    Minimum space requirement.
  181.           BENEFIT:  Prevents large archives from causing a disk full error upon
  182.                     processing.
  183.  
  184.      ■    Definable archive program names and archive command line
  185.           options/switches.
  186.           BENEFIT:  Allows the sysop to configure ProScribe to archive and
  187.                     unarchive uploads according to his/her needs, if necessary.
  188.                  ProScribe Archive Laboratory v1.0 Documentation      Page 5
  189.  
  190.  
  191.                               Program Descriptions
  192.         _________________________________________________________________
  193.  
  194.      When you unarchive the original ProScribe archive, you should see the
  195.      following files:
  196.  
  197.      PROGRAM NAME   Description
  198.      ------------   -----------
  199.  
  200.      WARNING .TXT   Read this BEFORE attempting to install ProScribe!
  201.      WHATS   .NEW   Whats new in this version of ProScribe
  202.      PROCESS .BAT   Sample batch file
  203.      PROSCRIB.CFG   ProScribe configuration file
  204.      PROSCRIB.DOC   Documentation for ProScribe
  205.      ADDCRC  .EXE   Removable BBS ad database "editor"
  206.      GETCRC  .EXE   Generates CRC values for files
  207.      MKERRLVL.EXE   Errorlevel generating program
  208.      PROSCRIB.EXE   Main program
  209.      PSCONFIG.EXE   ProScribe configuration utility
  210.      PSREG   .EXE   ProScribe registration utility
  211.      REGISTER.FRM   ProScribe registration form
  212.      CRC     .REC   Database for removable BBS ads
  213.      NOLABEL .TXT   Text file containing pipe commands
  214.      ARCID093.ZIP   ArcID v0.93 Archive Identification program
  215.  
  216.      The following are programs NOT included in the ProScribe archive, but are
  217.      needed for various ProScribe processes:
  218.  
  219.      PROGRAM NAME   DESCRIPTION
  220.      ------------   -----------
  221.  
  222.      ARJ     .EXE   Archive compress/extract utility
  223.      UNARJ   .EXE   Archive extract utility
  224.      LHA     .EXE   Archive compress/extract utility
  225.      PKZIP   .EXE   Archive compress utility
  226.      PKUNZIP .EXE   Archive extract utility
  227.      LABEL   .EXE   (or LABEL.COM) DOS program
  228.      SCAN    .EXE   McAfee's virus checker
  229.      
  230.      WARNING:  DO NOT RUN PROSCRIBE OUT OF ITS WORK DIRECTORY.  ProScribe
  231.      deletes the contents of the current directory where it was started from. 
  232.      Therefore ProScribe should only be started from a "scratch" directory which
  233.      does not contain important files.  Read the documentation completely before
  234.      running ProScribe.
  235.                  ProScribe Archive Laboratory v1.0 Documentation      Page 6
  236.  
  237.  
  238.                                  Status Display
  239.         _________________________________________________________________
  240.  
  241.      When ProScribe is operating, it presents the local display and the remote
  242.      display with a status display.  For example:
  243.  
  244. ╒═════════════════════════════════════════════════════════════════════════════╕
  245. │                 ██                  ██                  ██                  │
  246. │                 ██                  ██                  ██                  │
  247. │                 ██                  ██                  ██                  │
  248. │           ██████████████      ██████████████      ██████████████            │
  249. │                 ██                  ██                  ██                  │
  250. │                 ██                  ██                  ██                  │
  251. │                 ██                  ██                  ██  (TM)            │
  252. │                                                                             │
  253. │                      ProScribe Archive Laboratory v1.0                      │
  254. │                           Written By Brett Nyborg                           │
  255. │                  Registered To: Unregistered Evaluation Copy                │
  256. ╘═════════════════════════════════════════════════════════════════════════════╛
  257.  
  258.  ╒═══════════════════╡ ProScribe Archive Laboratory v1.0ß ╞══════════════════╕
  259.  │         Unzip  ■   Scan  ■   BBS Ads  ■   Zip  ■   Commenting  ■          │
  260.  │                                                                           │
  261.  │   Status> Checking for removable BBS ads                                  │
  262.  │   ███████████████████████████░░░░░░░░░░░░░░░░░░░░░░░  52%                 │
  263.  │   Ads left: 27     Ads Completed: 31                                      │
  264.  ╘═════════════════════════════╡ PLEASE REGISTER ╞═══════════════════════════╛
  265.  
  266.      The first window contains the program identification and copyright.  When
  267.      you register your copy of ProScribe, this window will also show the name
  268.      ProScribe is registered to.
  269.  
  270.      The second window, or "Status" window, shows the upload processing in
  271.      progress.  This window includes six items:
  272.  
  273.           1.   The ProScribe Archive Laboratory title
  274.           2.   The status light line
  275.           3.   The verbal status line of upload processing progress
  276.           4.   The BBS ad removal status bar
  277.           5.   The BBS ad removal status counters
  278.           6.   The desperate cry to register ProScribe!
  279.  
  280.      Description of the Status Window Items
  281.      --------------------------------------
  282.  
  283.           1.   The ProScribe Archive Laboratory title.  This line is static,
  284.                except for its color.
  285.  
  286.           2.   The status light line.  This line shows the current general
  287.                operation in progress by activating activity lights (the ■'s).
  288.  
  289.  
  290.                  ProScribe Archive Laboratory v1.0 Documentation      Page 7
  291.  
  292.  
  293.           3.   The verbal status line of upload processing progress.  This
  294.                indicates, in plain text, the operation that is being performed.
  295.  
  296.           4.   The BBS ad removal status bar.  This is a graphical indicator of
  297.                the progress of the BBS ad removal process.  It shows progress on
  298.                a 100% scale, and includes a numerical percentage value to the
  299.                right of the status bar.
  300.  
  301.           5.   The BBS ad removal status counters.  These show exactly how many
  302.                ads are left to process, and how many have been processed
  303.                already.
  304.  
  305.           6.   The desperate cry to register ProScribe!  This is a blatant cry
  306.                to support the shareware revolution, in the form of an incessant,
  307.                blinking red message to PLEASE REGISTER this fine product.  As
  308.                soon as you register ProScribe, this message will go away.
  309.                  ProScribe Archive Laboratory v1.0 Documentation      Page 8
  310.  
  311.  
  312.                  ProScribe Installation / Configuration Utility
  313.         _________________________________________________________________
  314.  
  315.      ProScribe Installation
  316.      ----------------------
  317.  
  318.           Select a directory in your PATH statement for ProScribe and its
  319.      associated files to reside in.  You may create a new directory exclusively
  320.      for ProScribe.  ProScribe will function properly as long as the directory
  321.      it resides in is included in your PATH statement.  Please refer to your DOS
  322.      manual if you are unfamiliar with the operation of the PATH statement.
  323.  
  324.           Select the directory that you wish to install ProScribe into by using
  325.      the CD command.  For example:
  326.  
  327.                CD\PROSCRIB
  328.  
  329.      Next, unarchive the ProScribe archive into this directory.  Included in the
  330.      ProScribe archive are miscellaneous archives, like ARCID093.ZIP, etc.,
  331.      which are required for ProScribe to function properly, and which also need
  332.      to be unarchived in the same directory.
  333.  
  334.           The next step is to configure ProScribe.  Run the included setup
  335.      program PSCONFIG.EXE.  You will be presented with a full screen display
  336.      that shows the following options:
  337.  
  338.                Path Names
  339.                Archivers
  340.                Colors
  341.                COM Port
  342.                Archive Comments
  343.                Toggles
  344.                Miscellaneous
  345.  
  346.      Navigating Through the ProScribe Setup Utility
  347.      ----------------------------------------------
  348.  
  349.      Generally, to navigate through ProScribe's menus, you use the up/down arrow
  350.      keys to select the menus and options and ENTER to enter menus and/or
  351.      modify/select options.  On the Minimum Space Free option from the
  352.      Miscellaneous menu, + and - keys can be used to increment and decrement the
  353.      value by 100,000 bytes.  Further, ] and [ keys can be used to increment and
  354.      decrement the value by 1,000,000 bytes.  On the Latest Date Necessary
  355.      option from the Miscellaneous menu, the + and - keys can be used to
  356.      increment and decrement the month field, and the ] and [ keys can be used
  357.      to increment and decrement the year field.
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.                  ProScribe Archive Laboratory v1.0 Documentation      Page 9
  365.  
  366.  
  367.      Using the ESC key, you can abort changes in:
  368.  
  369.  
  370.           Any text editing fields, such as the path names and archivers
  371.           The color selection sub-menus
  372.           The default archiving comment sub-menu
  373.  
  374.      Otherwise, the ESC key exits current menu, saving changes.  Lastly, the ESC
  375.      key exits the program, updating the configuration file with any changes.
  376.  
  377.      Path Names
  378.      ----------
  379.  
  380.      The first line under this menu is the directory where all unarchiving,
  381.      scanning, and re-archiving of incoming uploads is done.  You must create
  382.      this directory on your own for ProScribe to work.  For example:
  383.  
  384.           C:\PROSCRIB\TEMP\
  385.  
  386.      Do not use this directory for any other programs because ProScribe will
  387.      delete the contents of this directory after it processes a file.
  388.  
  389.      The second line under this menu is a complete path and filename of the text
  390.      file that ProScribe will use as a log file.  This log file will include
  391.      information, such as, the beginning and ending times of each ProScribe
  392.      session, each file that was processed, various status and error messages,
  393.      BBS ads removed, etc.  For example:
  394.  
  395.           C:\PROSCRIBE\UPLOAD.LOG
  396.  
  397.      The third line under this menu is a directory where ProScribe will place
  398.      uploads that did not pass any of the ProScribe tests/processes.  For
  399.      example:
  400.  
  401.           C:\BBS\HOLD\
  402.  
  403.      The fourth and fifth lines under this menu are full path(s) and filename(s)
  404.      of BBS ads that you can specify ProScribe to insert into incoming uploads,
  405.      if applicable.  You can specify "NUL" in these two lines to completely
  406.      disable BBS ad insertion.  Otherwise, specify up to two BBS ads that you
  407.      wish to insert into incoming uploads.  If you specify only one, make sure
  408.      the other line says "NUL".  For example:
  409.  
  410.           C:\PROSCRIB\BBS1.AD
  411.           C:\PROSCRIB\BBS2.AD
  412.      OR
  413.           NUL
  414.           NUL
  415.      OR
  416.  
  417.  
  418.  
  419.                  ProScribe Archive Laboratory v1.0 Documentation      Page 10
  420.  
  421.  
  422.           C:\PROSCRIB\BBS1.AD
  423.           NUL
  424.  
  425.  
  426.  
  427.      Archivers
  428.      ---------
  429.  
  430.      Lines 1 through 6 under this menu are the DOS filenames, and command line
  431.      options that will be used to archive/unarchive incoming uploads for
  432.      processing by ProScribe.  The defaults provided by the sample configuration
  433.      file with the ProScribe archive should work for most BBSes.  It is not
  434.      necessary to modify any items under this menu at the time of installation. 
  435.      However, if you have a setup where you need to modify some of the command
  436.      line switches and/or options, you may change the default settings to those
  437.      that suit your needs.
  438.  
  439.      Colors
  440.      ------
  441.  
  442.      Lines 1 through 8 under this menu are used to define ProScribe's color
  443.      scheme.  It is not necessary to modify any items under this menu at the
  444.      time of installation.  The defaults provided in the sample configuration
  445.      file with the ProScribe archive should appeal to most sysops/users. 
  446.      However, you may change the default settings to those that suit your needs.
  447.  
  448.      COM Port
  449.      --------
  450.  
  451.      Lines 1 through 4 under this menu are the COM ports that are supported by
  452.      ProScribe.  Select the port of your choice by pressing Enter on the desired
  453.      port.  (This should be the same COM port that your BBS uses)
  454.  
  455.      Archive Comments
  456.      ----------------
  457.  
  458.      Lines 1 through 10 under this menu are complete path(s) and filename(s) of
  459.      up to 10 different archive comments that you may insert into uploaded
  460.      archives.  Refer to the Miscellaneous menu to select the comment number you
  461.      wish to insert as a default, as described below under the Miscellaneous
  462.      menu description.  Currently, only ARJ and ZIP archives can be commented. 
  463.      Set any unused lines to "NUL".  To make installation easier, do not set
  464.      line 1 to "NUL" if you plan to use archive commenting.  You may set all of
  465.      these to "NUL" if you do not wish to comment your archives.  For example:
  466.  
  467.           C:\PROSCRIB\COMMENT1.TXT
  468.           C:\PROSCRIB\COMMENT2.TXT
  469.           ...etc.
  470.      OR
  471.  
  472.  
  473.  
  474.                  ProScribe Archive Laboratory v1.0 Documentation      Page 11
  475.  
  476.  
  477.           C:\PROSCRIB\COMMENT1.TXT
  478.           NUL
  479.           ...etc.
  480.      OR
  481.           NUL
  482.           NUL
  483.           ...etc.
  484.  
  485.  
  486.  
  487.      Toggles
  488.      -------
  489.  
  490.      Lines 1 through 5 under this menu are used to define how ProScribe should
  491.      behave.  For example:
  492.  
  493.      Always Rearchive.  If set to "Yes", all uploads will be re-archived,
  494.      regardless of whether or not any modifications were done to the file (BBS
  495.      ads removal, BBS ads insertion, archive commenting).  If set to "No",
  496.      uploads will be re-archived only when necessary.
  497.  
  498.      Place AV Stamp.  If set to "Yes", an AV stamp will be appended onto any ZIP
  499.      file that is re-archived.  It is generally recommended that if you use this
  500.      option, you should also set Always Rearchive to "Yes", above.  DO NOT SET
  501.      THIS OPTION TO YES IF YOU DO NOT HAVE A REGISTERED VERSION OF PKZIP, AS IT
  502.      WILL CAUSE THE SYSTEM TO LOCK UP.  (If this happens, you must press a key
  503.      locally to resume.)
  504.  
  505.      Always Add Volume Labels.  If set to "Yes", all uploads will correctly
  506.      handle possible volume labels inside archives.  If this option is used, you
  507.      must make sure that the work drive does not have any volume labels present
  508.      on it, as they will be inserted into every upload.  Also, you should also
  509.      "de-label" your work drive within your processing batch file.  The means to
  510.      do this are included.
  511.  
  512.      No Memory Check on SCAN.  If set to "Yes", ProScribe will instruct SCAN.EXE
  513.      to only check the files in the upload for viruses.  If set to "No",
  514.      SCAN.EXE will check both the files in the upload AND your computer's RAM
  515.      for viruses.  Setting this to "No" will make upload processing slower, as
  516.      SCAN.EXE will take extra time to scan the RAM.
  517.  
  518.      Always Add Archive Comment.  If set to "Yes", ProScribe will automatically
  519.      insert the default archive comment, as described below under the
  520.      Miscellaneous menu description.
  521.  
  522.      Miscellaneous
  523.      -------------
  524.  
  525.      Lines 1 through 3 under this menu are additional preferences that you may
  526.      specify.
  527.  
  528.  
  529.                  ProScribe Archive Laboratory v1.0 Documentation      Page 12
  530.  
  531.  
  532.      Minimum Space Free.  This is the minimum space requirement before ProScribe
  533.      unarchives the incoming upload.  If the minimum space free on your hard
  534.      drive where your work directory is located is less than the number
  535.      specified on this line, ProScribe will an error level indicating this
  536.      condition.
  537.  
  538.      Latest Date Necessary.  This is the date that the most recent file within
  539.      the upload must meet or exceed to pass the file date test.  If you do not
  540.      care about the file dates, you can set this to January 1980 (01/1980).
  541.  
  542.      Default Archive Comment.  This is the number of the default archive comment
  543.      that you wish to comment incoming uploads with.  Valid selections are 1-10.
  544.                  ProScribe Archive Laboratory v1.0 Documentation      Page 13
  545.  
  546.  
  547.                                Command Line Syntax
  548.         _________________________________________________________________
  549.  
  550.      The command line format to run ProScribe is as follows:
  551.  
  552.           PROSCRIB.EXE <C:\UD\ARCHIVE.EXT> [/c#]
  553.  
  554.      Upon execution, ProScribe will look for a complete path and filename of the
  555.      upload to be processed and an optional switch indicating the comment number
  556.      to be inserted into the upload.  Command line parameter and option are not
  557.      case sensitive.
  558.  
  559.      If you do not specify a complete path and filename as a command line
  560.      parameter, ProScribe will exit with an archive identification error.  For
  561.      example:
  562.  
  563.           PROSCRIB.EXE C:\UD\TESTFILE.ZIP
  564.      OR
  565.           PROSCRIB.EXE C:\UD\TESTFILE.ZIP /c1
  566.      AND NOT
  567.           PROSCRIB.EXE TESTFILE.ZIP
  568.                  ProScribe Archive Laboratory v1.0 Documentation      Page 14
  569.  
  570.  
  571.                              Batch File Construction
  572.         _________________________________________________________________
  573.  
  574.           In order for ProScribe to run correctly, it must be called from a
  575.      batch file after an upload is received on your BBS.
  576.  
  577.      The format for this batch file should be as follows:
  578.  
  579.           @ECHO OFF
  580.           C:
  581.           CD\PROSCRIB\TEMP
  582.           PROSCRIB.EXE %1 %2
  583.           C:
  584.           CD\BBS
  585.  
  586.      DO NOT RUN PROSCRIBE FROM OUTSIDE THE WORK DIRECTORY.  For reference, the
  587.      work directory is defined in the ProScribe configuration utility. 
  588.      ProScribe does "house cleaning" of the work directory where it was called
  589.      from, and it will delete ALL FILES and DIRECTORIES, if created, in the work
  590.      directory.
  591.  
  592.      The %1 and %2 parameters instruct ProScribe:  the file name, and the
  593.      archive comment number to use.  The %1 parameter MUST be included,
  594.      otherwise ProScribe will show a help screen and return with a non-zero
  595.      errorlevel.  The %2 parameter may be used to override the default comment
  596.      number as defined in the ProScribe configuration utility.
  597.  
  598.      The following is the batch file included in the ProScribe archive.  It has
  599.      been written to run with Telegard v2.7 BBS.  However, it shows the correct
  600.      ways to handle errorlevels.
  601.  
  602.           @echo off
  603.           d:
  604.           cd \proscrib\temp
  605.           proscrib.exe %1 %2
  606.           if errorlevel=9 goto error9
  607.           if errorlevel=8 goto error8
  608.           if errorlevel=7 goto error7
  609.           if errorlevel=6 goto error6
  610.           if errorlevel=5 goto error5
  611.           if errorlevel=4 goto error4
  612.           if errorlevel=3 goto error3
  613.           if errorlevel=2 goto error2
  614.           if errorlevel=1 goto error1
  615.           if errorlevel=0 goto error0
  616.           echo Something went wrong in PROCESS.BAT
  617.           pause
  618.           goto end
  619.           :error9
  620.  
  621.  
  622.  
  623.                  ProScribe Archive Laboratory v1.0 Documentation      Page 15
  624.  
  625.  
  626.                   d:
  627.                   cd\bbs
  628.                   exit
  629.           
  630.           :error8
  631.                   d:
  632.                   cd\bbs
  633.                   exit
  634.           
  635.           :error7
  636.                   mkerrlvl 0
  637.                   d:
  638.                   cd\bbs
  639.                   exit
  640.           
  641.           :error6
  642.                   d:
  643.                   cd\bbs
  644.                   exit
  645.           
  646.           :error5
  647.                   d:
  648.                   cd\bbs
  649.                   exit
  650.           
  651.           :error4
  652.                   d:
  653.                   cd\bbs
  654.                   exit
  655.           
  656.           :error3
  657.                   d:
  658.                   cd\bbs
  659.                   exit
  660.           
  661.           :error2
  662.                   d:
  663.                   cd\bbs
  664.                   exit
  665.           
  666.           :error1
  667.                   d:
  668.                   cd\bbs
  669.                   exit
  670.           
  671.           :error0
  672.                   d:
  673.                   cd\bbs
  674.                   exit
  675.           
  676.  
  677.  
  678.                  ProScribe Archive Laboratory v1.0 Documentation      Page 16
  679.  
  680.  
  681.           :end
  682.                   d:
  683.                   cd\bbs
  684.                   exit
  685.  
  686.      Since Telegard BBS only accepts one errorlevel for success after integrity
  687.      testing, this batch file uses the program MKERRLVL.EXE to create
  688.      errorlevels of "0" wherever required.  This may be desirable where you wish
  689.      to classify certain errorlevels as acceptable (for example, errorlevel 7). 
  690.      (The MKERRLVL.EXE program is included in the ProScribe archive.)
  691.                  ProScribe Archive Laboratory v1.0 Documentation      Page 17
  692.  
  693.  
  694.                                    Errorlevels
  695.         _________________________________________________________________
  696.  
  697.           The following errorlevels are returned after ProScribe completes its
  698.      functions:
  699.  
  700.           Errorlevel     Description
  701.           ----------     -----------
  702.  
  703.                0         Processing completed OK, no errors
  704.                1         Not enough space free in the temporary archive
  705.                          directory
  706.                2         File uploaded not in ARJ, LZH or ZIP format
  707.                3         Virus detected by SCAN.EXE
  708.                4         Program error in SCAN.EXE (i.e., not enough memory to
  709.                          run)
  710.                5         No parameters specified on the command line (missing
  711.                          filename)
  712.                6         Archive identification (file isn't actually a valid
  713.                          archive, OR the actual file specified on the command
  714.                          line is not really there)
  715.                7         The user hung up, but the archive processed OK
  716.                8         The most recent file in archive did not pass the file
  717.                          date check
  718.                9         Configuration file not found in DOS path or current
  719.                          directory
  720.                  ProScribe Archive Laboratory v1.0 Documentation      Page 18
  721.  
  722.  
  723.                              The ADDCRC.EXE Program
  724.         _________________________________________________________________
  725.  
  726.           ADDCRC.EXE is a program that adds new records of files, to a file
  727.      called CRC.REC, that you do not want to accept as a part of an upload to
  728.      your BBS.  These can be BBS ads from other boards, specific files, etc. 
  729.      Upon encountering these files by their existing CRC in CRC.REC, ProScribe
  730.      can detect their CRC values and remove them from the upload.  Included with
  731.      the ProScribe archive is a database of known BBS ads that will be removed
  732.      by ProScribe.
  733.  
  734.           Command line syntax is:
  735.  
  736.                ADDCRC.EXE <PATH>
  737.  
  738.                Example:  ADDCRC C:\ADS\*.*
  739.                Example:  ADDCRC BBS.AD
  740.  
  741.           You can view the contents of CRC.REC by typing:
  742.  
  743.           ADDCRC /V
  744.      OR
  745.           ADDCRC /V /P     (to enable screen pausing)
  746.                  ProScribe Archive Laboratory v1.0 Documentation      Page 19
  747.  
  748.  
  749.                             The MKERRLVL.EXE Program
  750.         _________________________________________________________________
  751.  
  752.           The MKERRLVL.EXE program is a small utility that can be used to
  753.      generate any errorlevel from 0-255 within a batch file.  The only instance
  754.      to use this program would be if ProScribe is returning an errorlevel that
  755.      you wish to change to another value.  For instance, if ProScribe is
  756.      returning an errorlevel of 7, you can use the MKERRLVL program to return an
  757.      errorlevel of 0 to complete processing correctly.
  758.  
  759.           The format for the MKERRLVL.EXE program is:
  760.  
  761.                MKERRLVL.EXE 0
  762.  
  763.      This will instantly change any errorlevels in your batch file to a "0" or
  764.      whatever you definie the value on the command line.
  765.                  ProScribe Archive Laboratory v1.0 Documentation      Page 20
  766.  
  767.  
  768.                                    Bug Reports
  769.         _________________________________________________________________
  770.  
  771.      Known bugs:
  772.  
  773.      None that we know of.
  774.  
  775.      If you encounter any bugs in this program, please report them to us.  You
  776.      may call the BBSes listed below in the distribution sites and report them
  777.      via email, or you may send netmail to Brett Nyborg at Fidonet 1:114/139 or
  778.      USTGNet 85:823/130.
  779.  
  780.      If you have any suggestions for improving ProScribe, please write to us or
  781.      netmail us at address listed above.
  782.                  ProScribe Archive Laboratory v1.0 Documentation      Page 21
  783.  
  784.  
  785.                                   Registration
  786.         _________________________________________________________________
  787.  
  788.      Qty    Item                                    US  Price
  789.  
  790.      ___  Registration only ........................ @  $5 ea $________
  791.           (includes user name on ProScribe screen)
  792.  
  793.      ___  Registration & Future Upgrades ........... @ $15 ea $________
  794.           (includes user name on ProScribe screen &
  795.            next 3 updates sent through mail)
  796.           Please Specify:     _____ 5¼" disk OR
  797.                               _____ 3½" disk
  798.  
  799.                                                         TOTAL $________
  800.  
  801.      Remit To:           Brett Nyborg
  802.                          9238 S. Heather Dr.
  803.                          Tempe, AZ 85284
  804.  
  805.      Name _____________________________________________________________
  806.  
  807.      Name to be displayed as registered to (Max 58 characters):
  808.  
  809.      __________________________________________________________________
  810.  
  811.      Company  _________________________________________________________
  812.      or BBS
  813.  
  814.      Address  _________________________________________________________
  815.  
  816.               _________________________________________________________
  817.  
  818.               _________________________________________________________
  819.  
  820.  
  821.      Payment by:  ___ Check (U.S. bank or branch) ___ Money Order
  822.  
  823.      Work Phone (____) _____________  Home Phone (____)  ______________
  824.  
  825.      Signature ________________________________________________________
  826.  
  827.      This program is not free!  You are hereby licensed to use this program for
  828.      a trial period of 30 days free of charge.  If, after 30 days, you decide
  829.      that you would like to continue using ProScribe, you must complete the
  830.      registration form (REGISTER.FRM) and return it to the author with the
  831.      required registration fee enclosed.
  832.                  ProScribe Archive Laboratory v1.0 Documentation      Page 22
  833.  
  834.  
  835.                                    DISCLAIMER
  836.  
  837.            IN NO EVENT WILL I BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING
  838.            ANY LOST PROFITS, LOST SAVINGS OR OTHER INCIDENTAL OR
  839.            CONSEQUENTIAL DAMAGES ARISING OUT OF YOUR USE OR INABILITY TO
  840.            USE THE PROGRAM, OR FOR ANY CLAIM BY ANY OTHER PARTY.
  841.                  ProScribe Archive Laboratory v1.0 Documentation      Page 23
  842.  
  843.  
  844.                                   Distributors
  845.         _________________________________________________________________
  846.  
  847.      You may download the latest version of ProScribe by calling:
  848.  
  849.      The Bazaar
  850.      602-964-2640
  851.      US Robotics HST/v42bis
  852.      Fidonet 1:114/139
  853.      USTG/ITCNet 85:823/130
  854.  
  855.      Central Intelligence Apparatus
  856.      602-730-5567
  857.      US Robotics HST/v42bis
  858.      X_Net/UN'INet
  859.      Node Name:  CIA
  860.      Node ID  :  3286
  861.  
  862.      You may also FREQ the latest version of ProScribe by FREQ'ing "PSAL*.*"
  863.      from Fidonet 1:114/139, or USTG/ITCNet 85:823/130.
  864.